AutoTweaker API/io.github.autotweaker.api

Package-level declarations

Types

I18nable

interface I18nable

允许对象通过 i18n 获取 I18nService。

object IO

用于告知 scope 使用 IO 线程池 Dispatchers.IO。（使用 scope(IO)）

JsonStorable

interface JsonStorable

允许对象通过 store 获取 JsonStore。

Loggable

interface Loggable

允许对象通过 log 获取 Logger，AutoTweaker 使用 logback 作为实现，插件仅需依赖 slf4j。

ObjectStorable

interface ObjectStorable

允许对象通过 objects 获取 ObjectStorage。

ServiceRegistry

class ServiceRegistry(val trace: (KClass<*>) -> TraceRecorder, val store: (KClass<*>) -> JsonStore, lazyObjects: () -> ObjectStorage, lazySetting: () -> SettingService, lazyI18n: () -> I18nService)

请不要构造此类或访问此类的伴生对象。

Traceable

interface Traceable

允许对象通过 trace 获取 TraceRecorder。

Properties

APP_NAME

const val APP_NAME: String

值为 AutoTweaker。

APP_NAME_LOWERCASE

val APP_NAME_LOWERCASE: String

值为 autotweaker。

CONFIG_PATH

val CONFIG_PATH: Path

存储配置及其他数据的目录，请使用提供的持久化 API 而不是直接在此路径下存放文件。

HOME

val HOME: Path

用户家目录。

i18n

val I18nable.i18n: I18nService

获取 AutoTweaker 提供的 I18nService。

INDENT

val INDENT: String

四个空格字符（" "）。

json

val json: Json

length

val Path.length: Int

路径字符串长度。

LINE

val LINE: String

长度为 10 的 -，也就是 ----------。

log

val Loggable.log: Logger

获取 Logger，请遵循日志规范，不要污染程序日志。

MASK_CHAR

const val MASK_CHAR: Char = '*'

星号，也就是 *。

objects

val ObjectStorable.objects: ObjectStorage

获取 AutoTweaker 提供的 ObjectStorage。

PLUGIN_PATH

val PLUGIN_PATH: Path

用于加载插件 jar 的目录，此目录中只有以 .jar 结尾的文件会被加载，jar 或 class 损坏的文件不会被加载。

SPACE

const val SPACE: Char = ' '

一个空格字符（' '）。

store

val JsonStorable.store: JsonStore

获取 AutoTweaker 提供的 JsonStore。同一类获取到的 JsonStore 始终相同，不同类获取到的 JsonStore 相互隔离。

TMP_HOST_PATH

val TMP_HOST_PATH: Path

容器内 /tmp/autotweaker 在宿主的挂载位置。

TMP_PATH

val TMP_PATH: Path

存放临时文件的目录，通常为 /tmp/autotweaker。

trace

val Traceable.trace: TraceRecorder

获取 AutoTweaker 提供的 TraceRecorder，自身作为 origin。

WORKSPACE_HOST_PATH

val WORKSPACE_HOST_PATH: Path

容器内 /workspace 在宿主的挂载位置，位于此路径下的工作区会被视为容器内工作区。

Functions

_LOG_TRACE_

fun Loggable.~~_LOG_TRACE_~~(content: String)

打印一条用于临时调试的 error 级别日志，特殊的命名便于通过自动化脚本扫描。

allNull

fun allNull(vararg items: Any?): Boolean

items 全部为 null 返回 true。

andLog

inline fun <T> T.andLog(logger: Logger, crossinline log: Logger.(T) -> Unit): T

用于在链式调用中插入日志，示例：

buildMessage

fun Throwable.buildMessage(): String

格式化异常信息，包括类名、message、cause。

cancelAndJoin

suspend fun CoroutineScope.cancelAndJoin()

取消并等待协程作用域的根 Job 完成，等价于 scope.coroutineContext.job.cancelAndJoin()。

DataUrl

fun DataUrl(mediatype: String, data: ByteArray): String

生成一个符合 RFC 2397 的 data URL

DataUrl

suspend fun ObjectStorable.DataUrl(mediatype: String, data: Sha256): String?

生成一个符合 RFC 2397 的 data URL

discard

fun <T> T.discard()

丢弃对象并返回 Unit。

fun <T, R> T.discard(result: R): R

丢弃对象并返回 result。

forEachBetween

inline fun <T> Iterable<T>.forEachBetween(action: (T) -> Unit, between: () -> Unit)

遍历一个 Iterable 对象并调用 action，在每两次遍历中间调用 between。

forEachParallel

inline suspend fun <T> Array<T>.forEachParallel(crossinline action: suspend (T) -> Unit)

inline suspend fun <T> Iterable<T>.forEachParallel(crossinline action: suspend (T) -> Unit)

inline suspend fun <K, V> Map<K, V>.forEachParallel(crossinline action: suspend (Map.Entry<K, V>) -> Unit)

forEach 并行版，会为每个条目启动一个协程来执行 action。

inline suspend fun <T> Array<T>.forEachParallel(limit: Int, crossinline action: suspend (T) -> Unit)

inline suspend fun <T> Iterable<T>.forEachParallel(limit: Int, crossinline action: suspend (T) -> Unit)

inline suspend fun <K, V> Map<K, V>.forEachParallel(limit: Int, crossinline action: suspend (Map.Entry<K, V>) -> Unit)

forEach 并行版，会为每个条目启动一个协程来执行 action，同时限制并发数为 limit。

format

fun SettingDef<SettingValue.ValString>.format(vararg args: Any?): String

获取一个字符串 SettingDef 的当前值，并通过 java.lang.String.format 填充字符串占位符。

get

fun <V : SettingValue<T>, T> SettingDef<V>.get(): T

对一个 SettingDef 调用 get 可以直接从数据库拿到当前配置值。

initServices

fun initServices(services: ServiceRegistry)

请不要调用此方法。

join

suspend fun CoroutineScope.join()

等待协程作用域的根 Job 完成，等价于 scope.coroutineContext.job.join()。

line

fun line(length: Int): String

输出 length 个 - 组成的字符串。

message

fun Throwable.message(): String

格式化异常信息，包括类名、message、cause。

orNow

@JvmName(name = "orNowNotNull")

fun Instant.~~orNow~~(): Instant

fun Instant?.orNow(): Instant

如果 this 为 null，返回 Clock.System.now，否则返回 this 本身。

orNull

fun <C : CharSequence> C.orNull(): C?

如果 CharSequence 为空，返回 null，否则返回 CharSequence 本身。

fun <T, C : Collection<T>> C.orNull(): C?

如果 Collection 为空，返回 null，否则返回 Collection 本身。

fun <T> Array<T>.orNull(): Array<T>?

如果 Array 为空，返回 null，否则返回 Array 本身。

fun <K, V> Map<K, V>.orNull(): Map<K, V>?

如果 Map 为空，返回 null，否则返回 Map 本身。

orThrow

@JvmName(name = "orThrowNotNull")

inline fun <T : Any> T.~~orThrow~~(exception: () -> Throwable): T

inline fun <T : Any> T?.orThrow(exception: () -> Throwable): T

popLine

fun StringBuilder.popLine(): String?

从 StringBuffer 中取出一行，找不到换行符返回 null。

scope

fun Loggable.scope(io: IO? = null): CoroutineScope

快速创建一个协程作用域，并在崩溃时记录日志。

set

fun <V : SettingValue<T>, T> SettingDef<V>.set(value: T)

对一个 SettingDef 调用 set 可以更新配置值。

times

operator fun Char.times(n: Int): String

为 Char 添加 * 操作符的支持，例如 '-' * 10 输出 10 个 -

operator fun String.times(n: Int): String

为 String 添加 * 操作符的支持，例如 "**" * 10，输出 20 个 *。

toMasked

fun String.toMasked(minLength: Int = 15, prefixKeep: Int = 5, suffixKeep: Int = 4): String

给敏感信息例如 api key 打码。

toUnicodeEscape

fun Char.toUnicodeEscape(): String

对一个字符进行 Unicode 转义，返回一个 Unicode 转义序列。

fun String.toUnicodeEscape(): String

对一个字符串进行 Unicode 转义，返回 6 倍大小的新字符串。

unescapeUnicode

fun String.unescapeUnicode(strict: Boolean = true): String

从一个可能包含 Unicode 转义序列的字符串中解码 Unicode 转义。

unreachable

fun unreachable(message: String? = null): Nothing

UUID

fun UUID(): UUID